irsense6.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef IRSENSE6_H
#define IRSENSE6_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"




#define IRSENSE6_CMD_FULL_MEASUREMENT       0xAA
 // irsense6_cmd



#define IRSENSE6_RAW_DATA_RESOLUTION        0xFFFFFFul
#define IRSENSE6_OBJ_TEMP_RES               130
#define IRSENSE6_OBJ_TEMP_OFFSET            20
#define IRSENSE6_AMB_TEMP_RES               105
#define IRSENSE6_AMB_TEMP_OFFSET            20

#define IRSENSE6_DEVICE_ADDRESS             0x38
 // irsense6_set



#define IRSENSE6_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST );
 // irsense6_map // irsense6

typedef struct
{
    // Output pins
    digital_out_t en;           
 
    // Modules
    i2c_master_t i2c;           
 
    // I2C slave address
    uint8_t slave_address;      
    
    uint8_t status;             
 
} irsense6_t;

typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
 
    pin_name_t en;              
 
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
 
} irsense6_cfg_t;

typedef enum
{
    IRSENSE6_OK = 0,
    IRSENSE6_ERROR = -1
 
} irsense6_return_value_t;


void irsense6_cfg_setup ( irsense6_cfg_t *cfg );

err_t irsense6_init ( irsense6_t *ctx, irsense6_cfg_t *cfg );

err_t irsense6_i2c_write ( irsense6_t *ctx, uint8_t *data_in, uint8_t len );

err_t irsense6_i2c_read ( irsense6_t *ctx, uint8_t *data_out, uint8_t len );

void irsense6_enable_device ( irsense6_t *ctx );

void irsense6_disable_device ( irsense6_t *ctx );

err_t irsense6_read_data ( irsense6_t *ctx, float *obj_temp, float *amb_temp );
 
#ifdef __cplusplus
}
#endif
#endif // IRSENSE6_H
 // irsense6
 
// ------------------------------------------------------------------------ END